Skip to content

chore/issue1/update-metadata#30

Merged
alperkent merged 9 commits into
mainfrom
alperkent/issue1
Jul 7, 2025
Merged

chore/issue1/update-metadata#30
alperkent merged 9 commits into
mainfrom
alperkent/issue1

Conversation

@alperkent
Copy link
Copy Markdown
Collaborator

Resolves #1.

…d description and examples, refine SECURITY.md reporting instructions, and modify pyproject.toml for additional authors and description clarity.
…E.md with style guide references and improved descriptions.
@alperkent alperkent requested a review from Asanto32 July 3, 2025 14:13
@alperkent alperkent added documentation Improvements or additions to documentation task A development task intended for Github Projects labels Jul 3, 2025
@alperkent alperkent self-assigned this Jul 3, 2025
@alperkent alperkent added documentation Improvements or additions to documentation task A development task intended for Github Projects labels Jul 3, 2025
@codecov
Copy link
Copy Markdown

codecov Bot commented Jul 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (2cee2aa) to head (467ffdd).

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #30   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          296       296           
=========================================
  Hits           296       296           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Collaborator

@Asanto32 Asanto32 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some small suggestions. I would add the PyPI publish workflow to this. Especially since you include that installation method in the README.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md
Comment thread .github/workflows/pypi.yaml Fixed
Comment thread .github/workflows/pypi.yaml Fixed
@alperkent alperkent requested a review from Asanto32 July 3, 2025 19:14
@alperkent
Copy link
Copy Markdown
Collaborator Author

@Asanto32 made all the fixes you suggested and added the pypi workflow as well. Once we merge it should automatically publish! 🤞

Copy link
Copy Markdown
Collaborator

@Asanto32 Asanto32 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small question about the pypi CI but otherwise lgtm

ls -la dist/
python -c "import tarfile; tarfile.open('dist/*.tar.gz').getnames()" || true

- name: Publish to PyPI
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will this job work without the PYPI token?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

apparently it is more secure without the tokens using this OpenID Connect method. we'll see if it works lol

if: steps.version-check.outputs.version_changed == 'true'
run: uv build

- name: Verify build artifacts
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what's this job needed for?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's basically a sanity check that makes sure that the distribution artifacts exist and can be opened before attempting to upload them to PyPI. i wanted to try and see, if it adds too much overhead i'll remove it.

@alperkent alperkent merged commit 9911b5a into main Jul 7, 2025
23 checks passed
@alperkent alperkent deleted the alperkent/issue1 branch July 7, 2025 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation task A development task intended for Github Projects

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Task: Update package metadata

4 participants